<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: SimpleKeyedContainer.html 883 2014-05-07 02:45:34Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.vaadin7;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.util.Collection;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.util.HashMap;<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>/**<a name="line.13"></a>
<span class="sourceLineNo">014</span> * An {@link AbstractSimpleContainer} where the item IDs are generated from the items themselves<a name="line.14"></a>
<span class="sourceLineNo">015</span> * by the subclass-provided method {@link #getKeyFor}.<a name="line.15"></a>
<span class="sourceLineNo">016</span> *<a name="line.16"></a>
<span class="sourceLineNo">017</span> * &lt;p&gt;<a name="line.17"></a>
<span class="sourceLineNo">018</span> * Restriction: instances can never contain two objects whose keys are equal (in the sense of {@link Object#equals}).<a name="line.18"></a>
<span class="sourceLineNo">019</span> * &lt;/p&gt;<a name="line.19"></a>
<span class="sourceLineNo">020</span> *<a name="line.20"></a>
<span class="sourceLineNo">021</span> * @param &lt;I&gt; the item ID type<a name="line.21"></a>
<span class="sourceLineNo">022</span> * @param &lt;T&gt; the type of the Java objects that back each {@link com.vaadin.data.Item} in the container<a name="line.22"></a>
<span class="sourceLineNo">023</span> * @see AbstractSimpleContainer<a name="line.23"></a>
<span class="sourceLineNo">024</span> */<a name="line.24"></a>
<span class="sourceLineNo">025</span>@SuppressWarnings("serial")<a name="line.25"></a>
<span class="sourceLineNo">026</span>public abstract class SimpleKeyedContainer&lt;I, T&gt; extends AbstractSimpleContainer&lt;I, T&gt; {<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>    private HashMap&lt;I, T&gt; objectMap = new HashMap&lt;&gt;(0);<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>    /**<a name="line.30"></a>
<span class="sourceLineNo">031</span>     * Constructor.<a name="line.31"></a>
<span class="sourceLineNo">032</span>     *<a name="line.32"></a>
<span class="sourceLineNo">033</span>     * &lt;p&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span>     * After using this constructor, subsequent invocations of {@link #setPropertyExtractor setPropertyExtractor()}<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * and {@link #setProperties setProperties()} are required to define the properties of this container<a name="line.35"></a>
<span class="sourceLineNo">036</span>     * and how to extract them.<a name="line.36"></a>
<span class="sourceLineNo">037</span>     */<a name="line.37"></a>
<span class="sourceLineNo">038</span>    public SimpleKeyedContainer() {<a name="line.38"></a>
<span class="sourceLineNo">039</span>    }<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span>    /**<a name="line.41"></a>
<span class="sourceLineNo">042</span>     * Constructor.<a name="line.42"></a>
<span class="sourceLineNo">043</span>     *<a name="line.43"></a>
<span class="sourceLineNo">044</span>     * &lt;p&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * After using this constructor, a subsequent invocation of {@link #setProperties setProperties()} is required<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * to define the properties of this container.<a name="line.46"></a>
<span class="sourceLineNo">047</span>     *<a name="line.47"></a>
<span class="sourceLineNo">048</span>     * @param propertyExtractor used to extract properties from the underlying Java objects;<a name="line.48"></a>
<span class="sourceLineNo">049</span>     *  may be null but then container is not usable until one is configured via<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * {@link #setPropertyExtractor setPropertyExtractor()}<a name="line.50"></a>
<span class="sourceLineNo">051</span>     */<a name="line.51"></a>
<span class="sourceLineNo">052</span>    public SimpleKeyedContainer(PropertyExtractor&lt;? super T&gt; propertyExtractor) {<a name="line.52"></a>
<span class="sourceLineNo">053</span>        this(propertyExtractor, null);<a name="line.53"></a>
<span class="sourceLineNo">054</span>    }<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span>    /**<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * Constructor.<a name="line.57"></a>
<span class="sourceLineNo">058</span>     *<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * &lt;p&gt;<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * After using this constructor, a subsequent invocation of {@link #setPropertyExtractor setPropertyExtractor()} is required<a name="line.60"></a>
<span class="sourceLineNo">061</span>     * to define how to extract the properties of this container; alternately, subclasses can override<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * {@link #getPropertyValue getPropertyValue()}.<a name="line.62"></a>
<span class="sourceLineNo">063</span>     * &lt;/p&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span>     *<a name="line.64"></a>
<span class="sourceLineNo">065</span>     * @param propertyDefs container property definitions; null is treated like the empty set<a name="line.65"></a>
<span class="sourceLineNo">066</span>     */<a name="line.66"></a>
<span class="sourceLineNo">067</span>    protected SimpleKeyedContainer(Collection&lt;? extends PropertyDef&lt;?&gt;&gt; propertyDefs) {<a name="line.67"></a>
<span class="sourceLineNo">068</span>        this(null, propertyDefs);<a name="line.68"></a>
<span class="sourceLineNo">069</span>    }<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span>    /**<a name="line.71"></a>
<span class="sourceLineNo">072</span>     * Constructor.<a name="line.72"></a>
<span class="sourceLineNo">073</span>     *<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * @param propertyExtractor used to extract properties from the underlying Java objects;<a name="line.74"></a>
<span class="sourceLineNo">075</span>     *  may be null but then container is not usable until one is configured via<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * {@link #setPropertyExtractor setPropertyExtractor()}<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * @param propertyDefs container property definitions; null is treated like the empty set<a name="line.77"></a>
<span class="sourceLineNo">078</span>     */<a name="line.78"></a>
<span class="sourceLineNo">079</span>    public SimpleKeyedContainer(PropertyExtractor&lt;? super T&gt; propertyExtractor, Collection&lt;? extends PropertyDef&lt;?&gt;&gt; propertyDefs) {<a name="line.79"></a>
<span class="sourceLineNo">080</span>        super(propertyExtractor, propertyDefs);<a name="line.80"></a>
<span class="sourceLineNo">081</span>    }<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span>    /**<a name="line.83"></a>
<span class="sourceLineNo">084</span>     * Constructor.<a name="line.84"></a>
<span class="sourceLineNo">085</span>     *<a name="line.85"></a>
<span class="sourceLineNo">086</span>     * &lt;p&gt;<a name="line.86"></a>
<span class="sourceLineNo">087</span>     * Properties will be determined by the {@link ProvidesProperty &amp;#64;ProvidesProperty} and<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * {@link ProvidesPropertySort &amp;#64;ProvidesPropertySort} annotated methods in the given class.<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * &lt;/p&gt;<a name="line.89"></a>
<span class="sourceLineNo">090</span>     *<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * @param type class to introspect for annotated methods<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * @throws IllegalArgumentException if {@code type} is null<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * @throws IllegalArgumentException if {@code type} has two {@link ProvidesProperty &amp;#64;ProvidesProperty}<a name="line.93"></a>
<span class="sourceLineNo">094</span>     *  or {@link ProvidesPropertySort &amp;#64;ProvidesPropertySort} annotated methods for the same property<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * @throws IllegalArgumentException if a {@link ProvidesProperty &amp;#64;ProvidesProperty}-annotated method with no<a name="line.95"></a>
<span class="sourceLineNo">096</span>     *  {@linkplain ProvidesProperty#value property name specified} has a name which cannot be interpreted as a bean<a name="line.96"></a>
<span class="sourceLineNo">097</span>     *  property "getter" method<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * @see ProvidesProperty<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * @see ProvidesPropertySort<a name="line.99"></a>
<span class="sourceLineNo">100</span>     * @see ProvidesPropertyScanner<a name="line.100"></a>
<span class="sourceLineNo">101</span>     */<a name="line.101"></a>
<span class="sourceLineNo">102</span>    protected SimpleKeyedContainer(Class&lt;? super T&gt; type) {<a name="line.102"></a>
<span class="sourceLineNo">103</span>        super(type);<a name="line.103"></a>
<span class="sourceLineNo">104</span>    }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span>    @Override<a name="line.106"></a>
<span class="sourceLineNo">107</span>    public T getJavaObject(Object itemId) {<a name="line.107"></a>
<span class="sourceLineNo">108</span>        if (itemId == null)<a name="line.108"></a>
<span class="sourceLineNo">109</span>            return null;<a name="line.109"></a>
<span class="sourceLineNo">110</span>        return this.objectMap.get(itemId);<a name="line.110"></a>
<span class="sourceLineNo">111</span>    }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span>    /**<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * Get the container item ID corresponding to the given underlying Java object which is wrapped by this container.<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * Objects are tested for equality using {@link Object#equals Object.equals()}.<a name="line.115"></a>
<span class="sourceLineNo">116</span>     *<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * &lt;p&gt;<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * This method uses an internal hash map for efficiency, and assumes that two underlying container objects that<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * are {@linkplain Object#equals equal} will have the same {@linkplain #getKeyFor key}.<a name="line.119"></a>
<span class="sourceLineNo">120</span>     * &lt;/p&gt;<a name="line.120"></a>
<span class="sourceLineNo">121</span>     *<a name="line.121"></a>
<span class="sourceLineNo">122</span>     * &lt;p&gt;<a name="line.122"></a>
<span class="sourceLineNo">123</span>     * This method is not used by this class but is defined as a convenience for subclasses.<a name="line.123"></a>
<span class="sourceLineNo">124</span>     * &lt;/p&gt;<a name="line.124"></a>
<span class="sourceLineNo">125</span>     *<a name="line.125"></a>
<span class="sourceLineNo">126</span>     * @param obj underlying container object<a name="line.126"></a>
<span class="sourceLineNo">127</span>     * @return item ID corresponding to {@code object}, or null if {@code object} is not found in this container<a name="line.127"></a>
<span class="sourceLineNo">128</span>     * @throws IllegalArgumentException if {@code object} is null<a name="line.128"></a>
<span class="sourceLineNo">129</span>     * @see #getItemIdForSame<a name="line.129"></a>
<span class="sourceLineNo">130</span>     */<a name="line.130"></a>
<span class="sourceLineNo">131</span>    public I getItemIdFor(T obj) {<a name="line.131"></a>
<span class="sourceLineNo">132</span>        if (obj == null)<a name="line.132"></a>
<span class="sourceLineNo">133</span>            throw new IllegalArgumentException("null object");<a name="line.133"></a>
<span class="sourceLineNo">134</span>        I key = this.getKeyFor(obj);<a name="line.134"></a>
<span class="sourceLineNo">135</span>        if (key == null)<a name="line.135"></a>
<span class="sourceLineNo">136</span>            throw new IllegalArgumentException("null key returned by getKeyFor() for object " + obj);<a name="line.136"></a>
<span class="sourceLineNo">137</span>        T candidate = this.objectMap.get(key);<a name="line.137"></a>
<span class="sourceLineNo">138</span>        return obj.equals(candidate) ? key : null;<a name="line.138"></a>
<span class="sourceLineNo">139</span>    }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span>    /**<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * Get the container item ID corresponding to the given underlying Java object which is wrapped by this container.<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * Objects are tested for equality using object equality, not {@link Object#equals Object.equals()}.<a name="line.143"></a>
<span class="sourceLineNo">144</span>     *<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * &lt;p&gt;<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * This method uses an internal hash map for efficiency.<a name="line.146"></a>
<span class="sourceLineNo">147</span>     * &lt;/p&gt;<a name="line.147"></a>
<span class="sourceLineNo">148</span>     *<a name="line.148"></a>
<span class="sourceLineNo">149</span>     * &lt;p&gt;<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * This method is not used by this class but is defined as a convenience for subclasses.<a name="line.150"></a>
<span class="sourceLineNo">151</span>     * &lt;/p&gt;<a name="line.151"></a>
<span class="sourceLineNo">152</span>     *<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * @param obj underlying container object<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * @return item ID corresponding to {@code object}, or null if {@code object} is not found in this container<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * @throws IllegalArgumentException if {@code object} is null<a name="line.155"></a>
<span class="sourceLineNo">156</span>     * @see #getItemIdFor<a name="line.156"></a>
<span class="sourceLineNo">157</span>     */<a name="line.157"></a>
<span class="sourceLineNo">158</span>    public I getItemIdForSame(T obj) {<a name="line.158"></a>
<span class="sourceLineNo">159</span>        if (obj == null)<a name="line.159"></a>
<span class="sourceLineNo">160</span>            throw new IllegalArgumentException("null object");<a name="line.160"></a>
<span class="sourceLineNo">161</span>        I key = this.getKeyFor(obj);<a name="line.161"></a>
<span class="sourceLineNo">162</span>        if (key == null)<a name="line.162"></a>
<span class="sourceLineNo">163</span>            throw new RuntimeException("null key returned by getKeyFor() for object " + obj);<a name="line.163"></a>
<span class="sourceLineNo">164</span>        T candidate = this.objectMap.get(key);<a name="line.164"></a>
<span class="sourceLineNo">165</span>        return obj == candidate ? key : null;<a name="line.165"></a>
<span class="sourceLineNo">166</span>    }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span>    @Override<a name="line.168"></a>
<span class="sourceLineNo">169</span>    protected void resetItemIds() {<a name="line.169"></a>
<span class="sourceLineNo">170</span>        this.objectMap = new HashMap&lt;&gt;();<a name="line.170"></a>
<span class="sourceLineNo">171</span>    }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span>    @Override<a name="line.173"></a>
<span class="sourceLineNo">174</span>    protected final I generateItemId(T obj) {<a name="line.174"></a>
<span class="sourceLineNo">175</span>        I key = this.getKeyFor(obj);<a name="line.175"></a>
<span class="sourceLineNo">176</span>        if (key == null)<a name="line.176"></a>
<span class="sourceLineNo">177</span>            throw new RuntimeException("null key returned by getKeyFor() for object " + obj);<a name="line.177"></a>
<span class="sourceLineNo">178</span>        T previous = this.objectMap.put(key, obj);<a name="line.178"></a>
<span class="sourceLineNo">179</span>        if (previous != null)<a name="line.179"></a>
<span class="sourceLineNo">180</span>            throw new RuntimeException("same key " + key + " used by two different objects " + previous + " and " + obj);<a name="line.180"></a>
<span class="sourceLineNo">181</span>        return key;<a name="line.181"></a>
<span class="sourceLineNo">182</span>    }<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span>    /**<a name="line.184"></a>
<span class="sourceLineNo">185</span>     * Get the key to be used as item ID for the given object.<a name="line.185"></a>
<span class="sourceLineNo">186</span>     * All objects in the container must have unique keys.<a name="line.186"></a>
<span class="sourceLineNo">187</span>     * This method must return the same key for the same object even if invoked multiple times.<a name="line.187"></a>
<span class="sourceLineNo">188</span>     *<a name="line.188"></a>
<span class="sourceLineNo">189</span>     * @param obj underlying container object<a name="line.189"></a>
<span class="sourceLineNo">190</span>     * @return key for object<a name="line.190"></a>
<span class="sourceLineNo">191</span>     */<a name="line.191"></a>
<span class="sourceLineNo">192</span>    protected abstract I getKeyFor(T obj);<a name="line.192"></a>
<span class="sourceLineNo">193</span>}<a name="line.193"></a>
<span class="sourceLineNo">194</span><a name="line.194"></a>




























































</pre>
</div>
</body>
</html>
